Obtains the class of a window.

OSStatus GetWindowClass (
    WindowRef window, 
    WindowClass *outClass
);

Parameter descriptions

window

A pointer to the window whose class you wish to obtain.

outClass

On input, a pointer to a value of type WindowClass. On return, this value identifies the class of the specified window. See “Window Class Constants” for a list of possible window classes. If the window was not originally created using the function CreateNewWindow, the class pointed to by the outClass parameter is always identified by the constant kDocumentWindowClass.

function result

A result code.

DISCUSSION

A window’s class categorizes the window for purposes of display (that is, both the window’s appearance and its display ordering) and tracking. A window’s class cannot be altered once the window has been created.

VERSION NOTES

This function is available with Mac OS 8.5 and later.

AVAILABILITY

Supported in Carbon. Available in Carbon 1.0.2 and later when running Mac OS 8.5 or later.

© 2000 Apple Computer, Inc. (Last Updated 6/30/2000)